Skip to content

Migrate simple JSON serialization from Newtonsoft.Json to System.Text.Json #1566

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Nov 25, 2025
Merged

Migrate simple JSON serialization from Newtonsoft.Json to System.Text.Json #1566

merged 3 commits into from
Nov 25, 2025

Conversation

@JamieMagee
Copy link
Member

@JamieMagee JamieMagee commented Nov 25, 2025 •
edited
Loading

Convert FileWritingService, ScanCommand, Mariner2ArtifactFilter, and DetectorProcessingService to use System.Text.Json for serialization.

LinuxScanner retained on Newtonsoft for now due to SyftOutput union types requiring custom converters.

@JamieMagee
Migrate simple JSON serialization from Newtonsoft.Json to System.Text…
6f4b7aa 
….Json

Convert `FileWritingService`, `ScanCommand`, Mariner2ArtifactFilter, and
`DetectorProcessingService` to use `System.Text.Json` for serialization.

`LinuxScanner` retained on Newtonsoft for now due to `SyftOutput` union types
requiring custom converters.
@JamieMagee JamieMagee requested a review from a team as a code owner November 25, 2025 04:56
@codecov
Copy link

codecov bot commented Nov 25, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.1%. Comparing base (59ab9db) to head (9f71017).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##            main   #1566     +/-   ##
=======================================
- Coverage   90.1%   90.1%   -0.1%     
=======================================
  Files        426     426             
  Lines      35981   35975      -6     
  Branches    2221    2221             
=======================================
- Hits       32442   32434      -8     
- Misses      3079    3080      +1     
- Partials     460     461      +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot finished reviewing on behalf of JamieMagee November 25, 2025 04:59
Copilot AI reviewed Nov 25, 2025
View reviewed changes
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR migrates JSON serialization from Newtonsoft.Json to System.Text.Json for four files: FileWritingService, ScanCommand, Mariner2ArtifactFilter, and DetectorProcessingService. The migration focuses on straightforward serialization scenarios, while complex use cases (like LinuxScanner with union types) remain on Newtonsoft.Json. The changes maintain backward compatibility by keeping model classes dual-annotated with both Newtonsoft.Json and System.Text.Json attributes during the transition.

Key Changes

  • Replaced direct JsonSerializer and JsonTextWriter usage with System.Text.Json.JsonSerializer static methods
  • Added JsonSerializerOptions configuration with JavaScriptEncoder.UnsafeRelaxedJsonEscaping and WriteIndented settings in FileWritingService
  • Updated imports: removed using Newtonsoft.Json; and added using System.Text.Json; (and System.Text.Encodings.Web where needed)

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
src/Microsoft.ComponentDetection.Orchestrator/Services/DetectorProcessingService.cs Updated telemetry serialization to use System.Text.Json
src/Microsoft.ComponentDetection.Orchestrator/Commands/ScanCommand.cs Migrated console output serialization to System.Text.Json with indented formatting
src/Microsoft.ComponentDetection.Detectors/linux/Filters/Mariner2ArtifactFilter.cs Updated telemetry record serialization to System.Text.Json
src/Microsoft.ComponentDetection.Common/FileWritingService.cs Refactored file writing methods to use System.Text.Json with custom serialization options including relaxed JSON escaping

Copilot AI review requested due to automatic review settings November 25, 2025 05:12
@JamieMagee JamieMagee force-pushed the users/jamagee/migrate-simple-json-to-stj branch from 58d9a84 to 9fd0bfc Compare November 25, 2025 05:12
Copilot finished reviewing on behalf of JamieMagee November 25, 2025 05:15
Copilot AI reviewed Nov 25, 2025
View reviewed changes
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 24 out of 24 changed files in this pull request and generated 1 comment.

@JamieMagee JamieMagee force-pushed the users/jamagee/migrate-simple-json-to-stj branch 2 times, most recently from 868c94e to dc179eb Compare November 25, 2025 05:30
Copilot AI review requested due to automatic review settings November 25, 2025 05:30
Copilot finished reviewing on behalf of JamieMagee November 25, 2025 05:34
@JamieMagee JamieMagee force-pushed the users/jamagee/migrate-simple-json-to-stj branch from dc179eb to 788c53e Compare November 25, 2025 05:35
Copilot AI reviewed Nov 25, 2025
View reviewed changes
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 25 out of 25 changed files in this pull request and generated no new comments.

@JamieMagee
System.Text.Json does not automatically serialize derived class pro…
9f71017 
…perties when the compile-time type is a base class
@JamieMagee JamieMagee requested a review from Copilot November 25, 2025 17:29
Copilot finished reviewing on behalf of JamieMagee November 25, 2025 17:32
Copilot AI reviewed Nov 25, 2025
View reviewed changes
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 25 out of 25 changed files in this pull request and generated 2 comments.

@JamieMagee JamieMagee merged commit 9cf0b1d into main Nov 25, 2025
34 of 36 checks passed
@JamieMagee JamieMagee deleted the users/jamagee/migrate-simple-json-to-stj branch November 25, 2025 18:43
@github-actions
Copy link

github-actions bot commented Nov 25, 2025

👋 Hi! It looks like you modified some files in the Detectors folder.
You may need to bump the detector versions if any of the following scenarios apply:

  • The detector detects more or fewer components than before
  • The detector generates different parent/child graph relationships than before
  • The detector generates different devDependencies values than before

If none of the above scenarios apply, feel free to ignore this comment 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@ryanbrandenburg ryanbrandenburg ryanbrandenburg approved these changes

@jasonpaulos jasonpaulos Awaiting requested review from jasonpaulos jasonpaulos is a code owner automatically assigned from microsoft/ose-component-detection-maintainers

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@JamieMagee @ryanbrandenburg